// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef NET_COOKIES_COOKIE_UTIL_H_
#define NET_COOKIES_COOKIE_UTIL_H_

#include <string>
#include <utility>
#include <vector>

#include "base/strings/string_piece.h"
#include "base/time/time.h"
#include "net/base/net_export.h"

class GURL;

namespace net {
namespace cookie_util {

    // Returns the effective TLD+1 for a given host. This only makes sense for http
    // and https schemes. For other schemes, the host will be returned unchanged
    // (minus any leading period).
    NET_EXPORT std::string GetEffectiveDomain(const std::string& scheme,
        const std::string& host);

    // Determine the actual cookie domain based on the domain string passed
    // (if any) and the URL from which the cookie came.
    // On success returns true, and sets cookie_domain to either a
    //   -host cookie domain (ex: "google.com")
    //   -domain cookie domain (ex: ".google.com")
    NET_EXPORT bool GetCookieDomainWithString(const GURL& url,
        const std::string& domain_string,
        std::string* result);

    // Returns true if a domain string represents a host-only cookie,
    // i.e. it doesn't begin with a leading '.' character.
    NET_EXPORT bool DomainIsHostOnly(const std::string& domain_string);

    // Parses the string with the cookie time (very forgivingly).
    NET_EXPORT base::Time ParseCookieTime(const std::string& time_string);

    // Convenience for converting a cookie origin (domain and https pair) to a URL.
    NET_EXPORT GURL CookieOriginToURL(const std::string& domain, bool is_https);

    // A ParsedRequestCookie consists of the key and value of the cookie.
    typedef std::pair<base::StringPiece, base::StringPiece> ParsedRequestCookie;
    typedef std::vector<ParsedRequestCookie> ParsedRequestCookies;

    // Assumes that |header_value| is the cookie header value of a HTTP Request
    // following the cookie-string schema of RFC 6265, section 4.2.1, and returns
    // cookie name/value pairs. If cookie values are presented in double quotes,
    // these will appear in |parsed_cookies| as well. Assumes that the cookie
    // header is written by Chromium and therefore well-formed.
    NET_EXPORT void ParseRequestCookieLine(const std::string& header_value,
        ParsedRequestCookies* parsed_cookies);

    // Writes all cookies of |parsed_cookies| into a HTTP Request header value
    // that belongs to the "Cookie" header. The entries of |parsed_cookies| must
    // already be appropriately escaped.
    NET_EXPORT std::string SerializeRequestCookieLine(
        const ParsedRequestCookies& parsed_cookies);

} // namespace cookie_util
} // namespace net

#endif // NET_COOKIES_COOKIE_UTIL_H_
